Klasse HighlightData.Highlight

java.lang.Object

java.awt.geom.RectangularShape

java.awt.geom.Rectangle2D

java.awt.Rectangle

com.inet.pdfc.generator.message.HighlightData.Highlight

Alle implementierten Schnittstellen:

Shape, Serializable, Cloneable

Umschließende Schnittstelle:

HighlightData

@JsonData
public static class HighlightData.Highlight
extends Rectangle

Represents a highlight area on a certain page. The coordinates are in pixels an relative to the unscaled page image coordinates

Siehe auch:

• Serialisierte Form

Verschachtelte Klassen - Übersicht

Verschachtelte Klassen

Modifikator und Typ	Klasse	Beschreibung
static enum	HighlightData.Highlight.Appearance	Appearances of a highlight.

Von Klasse geerbte verschachtelte Klassen/Schnittstellen Rectangle2D

Rectangle2D.Double, Rectangle2D.Float

Feldübersicht

Von Klasse geerbte Felder Rectangle

height, width, x, y

Von Klasse geerbte Felder Rectangle2D

OUT_BOTTOM, OUT_LEFT, OUT_RIGHT, OUT_TOP

Konstruktorübersicht

Konstruktoren

Konstruktor	Beschreibung
Highlight(int x, int y, int width, int height, String caption, HighlightData.Highlight.Appearance appearance, Color color)	Creates the highlight area
Highlight(Rectangle bounds, String caption, HighlightData.Highlight.Appearance appearance, Color color)	Creates the highlight area

Methodenübersicht

Modifikator und Typ	Methode	Beschreibung
boolean	contains(int x, int y)
HighlightData.Highlight.Appearance	getAppearance()	Returns the appearance.
String	getCaption()	Returns the caption to be displayed in the area
Color	getColor()	The base color to draw this highlight
Image	getImage()	Returns the image.
String	getRenderCacheKey()	Returns the key of the render cache entry for drawing this highlight.
String	getType()	Returns the type.
boolean	isAnnotation()	Returns a flag indicating this highlight represents an annotation.
void	setImage(Image image)	Sets the image.
void	setRenderCacheKey(String renderCacheKey)	Sets the key of the render cache entry for drawing this highlight.
void	setType(String type)	Sets the type.

Von Klasse geerbte Methoden Rectangle

add, add, add, contains, contains, contains, createIntersection, createUnion, equals, getBounds, getBounds2D, getHeight, getLocation, getSize, getWidth, getX, getY, grow, inside, intersection, intersects, isEmpty, move, outcode, reshape, resize, setBounds, setBounds, setLocation, setLocation, setRect, setSize, setSize, toString, translate, union

Von Klasse geerbte Methoden Rectangle2D

add, add, add, contains, contains, getPathIterator, getPathIterator, hashCode, intersect, intersects, intersectsLine, intersectsLine, outcode, setFrame, setRect, union

Von Klasse geerbte Methoden RectangularShape

clone, contains, contains, getCenterX, getCenterY, getFrame, getMaxX, getMaxY, getMinX, getMinY, intersects, setFrame, setFrame, setFrameFromCenter, setFrameFromCenter, setFrameFromDiagonal, setFrameFromDiagonal

Von Klasse geerbte Methoden Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Von Schnittstelle geerbte Methoden Shape

contains, contains, contains, contains, getPathIterator, getPathIterator, intersects, intersects

Konstruktordetails

Highlight

public Highlight(Rectangle bounds,
 String caption,
 HighlightData.Highlight.Appearance appearance,
 Color color)

Creates the highlight area

Parameter:

bounds - the bounds of the highlight

caption - the caption to be displayed INSIDE the area, may be null

appearance - indicates how to draw the highlight

color - the base color for this highlight. Note that the Alpha channel will be ignored an set by the painter

Highlight

public Highlight(int x,
 int y,
 int width,
 int height,
 String caption,
 HighlightData.Highlight.Appearance appearance,
 Color color)

Creates the highlight area

Parameter:

x - the x-offset

y - the y-offset

width - the width in PX

height - the height in PX

caption - the caption to be displayed INSIDE the area, may be null

appearance - indicates how to draw the highlight

color - the base color for this highlight. Note that the Alpha channel will be ignored an set by the painter

Methodendetails

getCaption

public String getCaption()

Returns the caption to be displayed in the area

Gibt zurück:

the caption to be displayed in the area, null if there is none

getColor

public Color getColor()

The base color to draw this highlight

Gibt zurück:

the base color to draw this highlight

getImage

public Image getImage()

Returns the image.

Gibt zurück:

the image.

setImage

public void setImage(Image image)

Sets the image.

Parameter:

image - the image

isAnnotation

public boolean isAnnotation()

Returns a flag indicating this highlight represents an annotation.

Gibt zurück:

true if this highlight represents an annotation

setType

public void setType(String type)

Sets the type.

Parameter:

type - the type.

getType

public String getType()

Returns the type.

Gibt zurück:

the type

getAppearance

public HighlightData.Highlight.Appearance getAppearance()

Returns the appearance.

Gibt zurück:

the appearance.

getRenderCacheKey

public String getRenderCacheKey()

Returns the key of the render cache entry for drawing this highlight.

Gibt zurück:

the key of the render cache entry for drawing this highlight

setRenderCacheKey

public void setRenderCacheKey(String renderCacheKey)

Sets the key of the render cache entry for drawing this highlight.

Parameter:

renderCacheKey - the key of the render cache entry for drawing this highlight

contains

public boolean contains(int x,
 int y)

Setzt außer Kraft:

contains in Klasse Rectangle